Scheme Program Documentation Tools
نویسنده
چکیده
This paper describes and discusses two different Scheme documentation tools. The first is SchemeDoc, which is intended for documentation of the interfaces of Scheme libraries (APIs). The second is the Scheme Elucidator, which is for internal documentation of Scheme programs. Although the tools are separate and intended for different documentation purposes they are related to each other in several ways. Both tools are based on XML languages for tool setup and for documentation authoring. In addition, both tools rely on the LAML framework which—in a systematic way—makes an XML language available as a set of functions in Scheme. Finally, the Scheme Elucidator is able to integrate SchemeDoc resources as part of an internal documentation resource.
منابع مشابه
An Elucidative Programming Environment for Scheme (Incomplete Draft)
In this paper we describe a programming environment for Scheme that supports elucidative programming. Scheme is a programming language in the Lisp family. Elucidative programming is a variant of literate programming. Literate programming represents the idea of structuring the program as fragments that are contained in an essay that documents the program understanding. Elucidative programming is...
متن کاملAssessment of the Effect of Continuing Education Program on Nurse’s Knowledge, Attitude and Performance about Documentation
Background: Documentation is one of the nurses’ professional tasks, which is an important component of medical evidence and patient’s record. Finding effective teaching methods for enhancing nurses’ ability in documentation can be helpful. Aim: This study was performed to determine the effect of continuing education program on nurse’s knowledge, attitude and performance about documentation. Met...
متن کاملProceedings of the Fifth Workshop on Scheme and Functional Programming
This paper describes and discusses two different Scheme documentation tools. The first is SchemeDoc, which is intended for documentation of the interfaces of Scheme libraries (APIs). The second is the Scheme Elucidator, which is for internal documentation of Scheme programs. Although the tools are separate and intended for different documentation purposes they are related to each other in sever...
متن کاملThe Vicinity of Program Documentation Tools
Program documentation plays a vital role in almost all programming processes. Program documentation flows between separate tools of a modularized environment, and in between the components of an integrated development environment as well. In this paper we discuss the flow of program documentation between program development tools. In the central part of the paper we introduce a mapping of docum...
متن کاملMaintaining Program Understanding -- Issues, Tools, and Future Directions
The understanding of a program is a key aspect of software development. The understanding is a prerequisite for the initial development efforts. This paper is concerned with the challenge of maintaining the program understanding with the purpose of supporting later phases in the program life time. One approach to maintaining program understanding is to document decision and rationales behind a ...
متن کامل